r? @flip1995

(rust-highfive has picked a reviewer for you, use r? to override)

CCHelper → CcHelper and SAOnly → SaOnly looks pretty weird to me. In .Net, at least, two letter acronyms are in uppercase. See .Net documenation - Capitalization Conventions. The issue talks about VS plugins so those are probably the rules they are using. I tried to find some Rust documentation on capitalization conventions of acronyms but I didn't find anything.

Also, I think this might have to be pedantic, as it will generate excessive warnings in some projects.

CCHelper → CcHelper and SAOnly → SaOnly looks pretty weird to me. In .Net, at least, two letter acronyms are in uppercase. See .Net documenation - Capitalization Conventions. The issue talks about VS plugins so those are probably the rules they are using. I tried to find some Rust documentation on capitalization conventions of acronyms but I didn't find anything.

I have the same spontaneous feeling on two-letter acronyms but IMO they aren't exceptions in Rust given IoSlice, TypeId and GlObject.

Also, I think this might have to be pedantic, as it will generate excessive warnings in some projects.

If two-letter acronyms are exceptions pedantic is fair as the lint will be false-positive (including ID and IO) prone. If not I'd prefer this lint to be deny-by-default since the lint should be as broad as possible, considering the naming convention on acronyms are not intuitive for those who came from other languages.

The IoSlice example convinced me that two letter acronyms aren't an exception.

I'll let the reviewer decide on whether this should be pedantic or something else. I tested it on a bunch of crates and there weren't that many warnings.

The one issue I found is that it lints on globals created with lazy_static.

use lazy_static::lazy_static;

lazy_static! {
    /// This is an example for using doc comment attributes
    static ref EXAMPLE: u8 = 42;
}

fn main() {}

error: name `EXAMPLE` may contain capitalized acronym
  --> src/main.rs:11:16
   |
11 |     static ref EXAMPLE: u8 = 42;
   |                ^^^^^^^ help: consider making the acronym lowercase expect the initial letter: `Example`
   |
note: the lint level is defined here
  --> src/main.rs:1:9
   |

There probably needs to be a macro check somewhere.

I was also wondering if we should call the lint upper-case-acronyms to be consistent with the non-upper-case-globals rust lint.

I'll let the reviewer decide on whether this should be pedantic or something else. I tested it on a bunch of crates and there weren't that many warnings.

Got it. I guess I need opinions from others on its lint category.

The one issue I found is that it lints on globals created with lazy_static.

Very nice catch! lazy_static expands EXAMPLE to a struct, leading to being linted. Perhaps this lint should ignore macros.
I feel upper-case-acronyms is nicer than capitalized-acronyms, I'll rename it to that.

I'll make the changes next week as I have a lot to do right now.

@bors r+

Thanks!

📌 Commit 0ccb491 has been approved by flip1995

⌛ Testing commit 0ccb491 with merge e6665e4...

☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test
Approved by: flip1995
Pushing e6665e4 to master...